OnAttemptCheckInCopyProtection

SoftwareShield ClientProtector COM Component > ClientProtector (SSCProtector) Reference > OnAttemptCheckInCopyProtection

## OnAttemptCheckInCopyProtection

OnAttemptCheckInCopyProtection is an event function of the ClientProtector dispatch interface. When you attempt to Check-In an Activation, if the Activation belongs to a Release Copy-Protection Authorization Definition, this event will be synchronously called. Your application can give the user a "last chance" to abort the Check-In operation before it continues. Note that Serial Numbers that belong to other activation types do not invoke this event when Checked-In.

###### Syntax

HRESULT OnAttemptCheckInCopyProtection ( VARIANT_BOOL * AllowCheckIn ) ;

###### Parameters

AllowCheckIn

[OUT] This is (a pointer to) a boolean value that determines if the Check-In procedure should be allowed to continue.

###### Remarks

OnAttemptCheckInCopyProtection is an event function of the ClientProtector dispatch interface. When you attempt to Check-In an Activation, if the Activation belongs to a Release Copy-Protection Authorization Definition, this event will be synchronously called. Your application can give the user a "last chance" to abort the Check-In operation before it continues.

Note that Serial Numbers that belong to other activation types do not invoke this event when Checked-In.

If you are using Check-In Copy-Protection functionality in your license, you should implement this function. However, you can choose not to if you do not need to prompt the user.

The event handler provides a synchronous method for you to inform the user of the consequences of Checking-In the license activation and give them a last chance to abort the operation.

Note that SNCheckInCopyProtection always invokes this event. SNCheckInByID and SNCheckInBySN may invoke this event if the operation determines that the Check-In "belongs" to a Release Copy-Protection Authorization Definition.

Set AllowCheckIn to false if you wish to abort the Check-In operation.

Note that if you do not subscribe to the event, or you do subscribe to it, but fail to set the AllowCheckIn parameter to false - the Check-In will proceed.

See the SoftwareShield ClientProtector Control Flow Charts for more information about where this event fires and how it handles the logic around SNCheckInCopyProtection, SNCheckInByID and SNCheckInBySN.

###### Return Value

As with all COM function calls they return an HRESULT. HRESULT is a data type that is a 32-bit error or warning code. Check your compilers documentation for information on interpreting the HRESULT value.

###### Function Information

Exposed By Interface: | "ISSCProtector"
Exposed In COM Server Binaries: | "SSCProt.dll" and "SSCProtD.dll"